<!doctype html>
<html class="no-js" lang="en" data-content_root="../../">
  <head><meta charset="utf-8">
    <meta name="viewport" content="width=device-width,initial-scale=1">
    <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="../../genindex.html"><link rel="search" title="Search" href="../../search.html">

    <!-- Generated with Sphinx 8.2.3 and Furo 2025.09.25 -->
        <title>osxphotos.sidecars - osxphotos 0.74.2 documentation</title>
      <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=d111a655" />
    <link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?v=580074bf" />
    <link rel="stylesheet" type="text/css" href="../../_static/copybutton.css?v=76b2166b" />
    <link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?v=8dab3a3b" />
    
    


<style>
  body {
    --color-code-background: #f2f2f2;
  --color-code-foreground: #1e1e1e;
  
  }
  @media not print {
    body[data-theme="dark"] {
      --color-code-background: #202020;
  --color-code-foreground: #d0d0d0;
  
    }
    @media (prefers-color-scheme: dark) {
      body:not([data-theme="light"]) {
        --color-code-background: #202020;
  --color-code-foreground: #d0d0d0;
  
      }
    }
  }
</style></head>
  <body>
    
    <script>
      document.body.dataset.theme = localStorage.getItem("theme") || "auto";
    </script>
    

<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
  <symbol id="svg-toc" viewBox="0 0 24 24">
    <title>Contents</title>
    <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
      <path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
    </svg>
  </symbol>
  <symbol id="svg-menu" viewBox="0 0 24 24">
    <title>Menu</title>
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
      <line x1="3" y1="12" x2="21" y2="12"></line>
      <line x1="3" y1="6" x2="21" y2="6"></line>
      <line x1="3" y1="18" x2="21" y2="18"></line>
    </svg>
  </symbol>
  <symbol id="svg-arrow-right" viewBox="0 0 24 24">
    <title>Expand</title>
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
      <polyline points="9 18 15 12 9 6"></polyline>
    </svg>
  </symbol>
  <symbol id="svg-sun" viewBox="0 0 24 24">
    <title>Light mode</title>
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
      stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
      <circle cx="12" cy="12" r="5"></circle>
      <line x1="12" y1="1" x2="12" y2="3"></line>
      <line x1="12" y1="21" x2="12" y2="23"></line>
      <line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
      <line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
      <line x1="1" y1="12" x2="3" y2="12"></line>
      <line x1="21" y1="12" x2="23" y2="12"></line>
      <line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
      <line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
    </svg>
  </symbol>
  <symbol id="svg-moon" viewBox="0 0 24 24">
    <title>Dark mode</title>
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
      stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
      <path stroke="none" d="M0 0h24v24H0z" fill="none" />
      <path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
    </svg>
  </symbol>
  <symbol id="svg-sun-with-moon" viewBox="0 0 24 24">
    <title>Auto light/dark, in light mode</title>
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
      stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
      class="icon-custom-derived-from-feather-sun-and-tabler-moon">
      <path style="opacity: 50%" d="M 5.411 14.504 C 5.471 14.504 5.532 14.504 5.591 14.504 C 3.639 16.319 4.383 19.569 6.931 20.352 C 7.693 20.586 8.512 20.551 9.25 20.252 C 8.023 23.207 4.056 23.725 2.11 21.184 C 0.166 18.642 1.702 14.949 4.874 14.536 C 5.051 14.512 5.231 14.5 5.411 14.5 L 5.411 14.504 Z"/>
      <line x1="14.5" y1="3.25" x2="14.5" y2="1.25"/>
      <line x1="14.5" y1="15.85" x2="14.5" y2="17.85"/>
      <line x1="10.044" y1="5.094" x2="8.63" y2="3.68"/>
      <line x1="19" y1="14.05" x2="20.414" y2="15.464"/>
      <line x1="8.2" y1="9.55" x2="6.2" y2="9.55"/>
      <line x1="20.8" y1="9.55" x2="22.8" y2="9.55"/>
      <line x1="10.044" y1="14.006" x2="8.63" y2="15.42"/>
      <line x1="19" y1="5.05" x2="20.414" y2="3.636"/>
      <circle cx="14.5" cy="9.55" r="3.6"/>
    </svg>
  </symbol>
  <symbol id="svg-moon-with-sun" viewBox="0 0 24 24">
    <title>Auto light/dark, in dark mode</title>
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
      stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
      class="icon-custom-derived-from-feather-sun-and-tabler-moon">
      <path d="M 8.282 7.007 C 8.385 7.007 8.494 7.007 8.595 7.007 C 5.18 10.184 6.481 15.869 10.942 17.24 C 12.275 17.648 13.706 17.589 15 17.066 C 12.851 22.236 5.91 23.143 2.505 18.696 C -0.897 14.249 1.791 7.786 7.342 7.063 C 7.652 7.021 7.965 7 8.282 7 L 8.282 7.007 Z"/>
      <line style="opacity: 50%" x1="18" y1="3.705" x2="18" y2="2.5"/>
      <line style="opacity: 50%" x1="18" y1="11.295" x2="18" y2="12.5"/>
      <line style="opacity: 50%" x1="15.316" y1="4.816" x2="14.464" y2="3.964"/>
      <line style="opacity: 50%" x1="20.711" y1="10.212" x2="21.563" y2="11.063"/>
      <line style="opacity: 50%" x1="14.205" y1="7.5" x2="13.001" y2="7.5"/>
      <line style="opacity: 50%" x1="21.795" y1="7.5" x2="23" y2="7.5"/>
      <line style="opacity: 50%" x1="15.316" y1="10.184" x2="14.464" y2="11.036"/>
      <line style="opacity: 50%" x1="20.711" y1="4.789" x2="21.563" y2="3.937"/>
      <circle style="opacity: 50%" cx="18" cy="7.5" r="2.169"/>
    </svg>
  </symbol>
  <symbol id="svg-pencil" viewBox="0 0 24 24">
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
      stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-pencil-code">
      <path d="M4 20h4l10.5 -10.5a2.828 2.828 0 1 0 -4 -4l-10.5 10.5v4" />
      <path d="M13.5 6.5l4 4" />
      <path d="M20 21l2 -2l-2 -2" />
      <path d="M17 17l-2 2l2 2" />
    </svg>
  </symbol>
  <symbol id="svg-eye" viewBox="0 0 24 24">
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
      stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-eye-code">
      <path stroke="none" d="M0 0h24v24H0z" fill="none" />
      <path d="M10 12a2 2 0 1 0 4 0a2 2 0 0 0 -4 0" />
      <path
        d="M11.11 17.958c-3.209 -.307 -5.91 -2.293 -8.11 -5.958c2.4 -4 5.4 -6 9 -6c3.6 0 6.6 2 9 6c-.21 .352 -.427 .688 -.647 1.008" />
      <path d="M20 21l2 -2l-2 -2" />
      <path d="M17 17l-2 2l2 2" />
    </svg>
  </symbol>
</svg>

<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle site navigation sidebar">
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc" aria-label="Toggle table of contents sidebar">
<label class="overlay sidebar-overlay" for="__navigation"></label>
<label class="overlay toc-overlay" for="__toc"></label>

<a class="skip-to-content muted-link" href="#furo-main-content">Skip to content</a>



<div class="page">
  <header class="mobile-header">
    <div class="header-left">
      <label class="nav-overlay-icon" for="__navigation">
        <span class="icon"><svg><use href="#svg-menu"></use></svg></span>
      </label>
    </div>
    <div class="header-center">
      <a href="../../index.html"><div class="brand">osxphotos 0.74.2 documentation</div></a>
    </div>
    <div class="header-right">
      <div class="theme-toggle-container theme-toggle-header">
        <button class="theme-toggle" aria-label="Toggle Light / Dark / Auto color theme">
          <svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
          <svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
          <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
          <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
        </button>
      </div>
      <label class="toc-overlay-icon toc-header-icon no-toc" for="__toc">
        <span class="icon"><svg><use href="#svg-toc"></use></svg></span>
      </label>
    </div>
  </header>
  <aside class="sidebar-drawer">
    <div class="sidebar-container">
      
      <div class="sidebar-sticky"><a class="sidebar-brand" href="../../index.html">
  
  <span class="sidebar-brand-text">osxphotos 0.74.2 documentation</span>
  
</a><form class="sidebar-search-container" method="get" action="../../search.html" role="search">
  <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
  <input type="hidden" name="check_keywords" value="yes">
  <input type="hidden" name="area" value="default">
</form>
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
  <ul>
<li class="toctree-l1"><a class="reference internal" href="../../overview.html">OSXPhotos</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../tutorial.html">OSXPhotos Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../cli.html">OSXPhotos Command Line Interface (CLI)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../template_help.html">OSXPhotos Template System</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../package_overview.html">OSXPhotos Python Package Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../API_README.html">OSXPhotos Python API</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../reference.html">OSXPhotos Python Reference</a></li>
</ul>

</div>
</div>

      </div>
      
    </div>
  </aside>
  <div class="main">
    <div class="content">
      <div class="article-container">
        <a href="#" class="back-to-top muted-link">
          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
            <path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
          </svg>
          <span>Back to top</span>
        </a>
        <div class="content-icon-container">
          <div class="theme-toggle-container theme-toggle-content">
            <button class="theme-toggle" aria-label="Toggle Light / Dark / Auto color theme">
              <svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
              <svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
              <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
              <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
            </button>
          </div>
          <label class="toc-overlay-icon toc-content-icon no-toc" for="__toc">
            <span class="icon"><svg><use href="#svg-toc"></use></svg></span>
          </label>
        </div>
        <article role="main" id="furo-main-content">
          <h1>Source code for osxphotos.sidecars</h1><div class="highlight"><pre>
<span></span><span class="sd">&quot;&quot;&quot;Write sidecars for PhotoInfo objects&quot;&quot;&quot;</span>

<span class="kn">from</span><span class="w"> </span><span class="nn">__future__</span><span class="w"> </span><span class="kn">import</span> <span class="n">annotations</span>

<span class="kn">import</span><span class="w"> </span><span class="nn">dataclasses</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">logging</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">os</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">pathlib</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">functools</span><span class="w"> </span><span class="kn">import</span> <span class="n">cache</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">TYPE_CHECKING</span><span class="p">,</span> <span class="n">Callable</span>

<span class="kn">from</span><span class="w"> </span><span class="nn">mako.template</span><span class="w"> </span><span class="kn">import</span> <span class="n">Template</span>

<span class="kn">from</span><span class="w"> </span><span class="nn">._constants</span><span class="w"> </span><span class="kn">import</span> <span class="p">(</span>
    <span class="n">_OSXPHOTOS_NONE_SENTINEL</span><span class="p">,</span>
    <span class="n">_TEMPLATE_DIR</span><span class="p">,</span>
    <span class="n">_UNKNOWN_PERSON</span><span class="p">,</span>
    <span class="n">_XMP_TEMPLATE_NAME</span><span class="p">,</span>
    <span class="n">_XMP_TEMPLATE_NAME_BETA</span><span class="p">,</span>
    <span class="n">SIDECAR_EXIFTOOL</span><span class="p">,</span>
    <span class="n">SIDECAR_JSON</span><span class="p">,</span>
    <span class="n">SIDECAR_XMP</span><span class="p">,</span>
<span class="p">)</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">._version</span><span class="w"> </span><span class="kn">import</span> <span class="n">__version__</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">.exifwriter</span><span class="w"> </span><span class="kn">import</span> <span class="n">ExifOptions</span><span class="p">,</span> <span class="n">ExifWriter</span><span class="p">,</span> <span class="n">_ExifMixin</span><span class="p">,</span> <span class="n">exif_options_from_options</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">.export_db</span><span class="w"> </span><span class="kn">import</span> <span class="n">ExportDBTemp</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">.exportoptions</span><span class="w"> </span><span class="kn">import</span> <span class="n">ExportOptions</span><span class="p">,</span> <span class="n">ExportResults</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">.fileutil</span><span class="w"> </span><span class="kn">import</span> <span class="n">FileUtilMacOS</span><span class="p">,</span> <span class="n">FileUtilShUtil</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">.metadata_reader</span><span class="w"> </span><span class="kn">import</span> <span class="n">get_sidecar_for_file</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">.photoinfo_file</span><span class="w"> </span><span class="kn">import</span> <span class="n">render_photo_template_from_filepath</span><span class="p">,</span> <span class="n">strip_edited_suffix</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">.phototemplate</span><span class="w"> </span><span class="kn">import</span> <span class="n">PhotoTemplate</span><span class="p">,</span> <span class="n">RenderOptions</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">.platform</span><span class="w"> </span><span class="kn">import</span> <span class="n">is_macos</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">.rich_utils</span><span class="w"> </span><span class="kn">import</span> <span class="n">add_rich_markup_tag</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">.touch_files</span><span class="w"> </span><span class="kn">import</span> <span class="n">touch_files</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">.utils</span><span class="w"> </span><span class="kn">import</span> <span class="n">hexdigest</span>

<span class="k">if</span> <span class="n">TYPE_CHECKING</span><span class="p">:</span>
    <span class="kn">from</span><span class="w"> </span><span class="nn">.photoinfo</span><span class="w"> </span><span class="kn">import</span> <span class="n">PhotoInfo</span>

<span class="c1"># Global to hold the compiled XMP template</span>
<span class="c1"># This is expensive to compile so we only want to do it once</span>
<span class="n">_global_xmp_template</span><span class="p">:</span> <span class="n">Template</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span>

<span class="n">logger</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="s2">&quot;osxphotos&quot;</span><span class="p">)</span>

<span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span>
    <span class="s2">&quot;SidecarWriter&quot;</span><span class="p">,</span>
    <span class="s2">&quot;exiftool_json_sidecar&quot;</span><span class="p">,</span>
    <span class="s2">&quot;xmp_sidecar&quot;</span><span class="p">,</span>
    <span class="s2">&quot;get_sidecar_file_with_template&quot;</span><span class="p">,</span>
<span class="p">]</span>


<span class="k">class</span><span class="w"> </span><span class="nc">UserSidecarError</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
<span class="w">    </span><span class="sd">&quot;&quot;&quot;Generated if there&#39;s an error in user sidecar template so it can be handled by export CLI&quot;&quot;&quot;</span>

    <span class="k">pass</span>


<span class="nd">@dataclasses</span><span class="o">.</span><span class="n">dataclass</span>
<span class="k">class</span><span class="w"> </span><span class="nc">SidecarVars</span><span class="p">:</span>
    <span class="n">description</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span>
    <span class="n">extension</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span>
    <span class="n">keywords</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="n">dataclasses</span><span class="o">.</span><span class="n">field</span><span class="p">(</span><span class="n">default_factory</span><span class="o">=</span><span class="nb">list</span><span class="p">)</span>
    <span class="n">persons</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="n">dataclasses</span><span class="o">.</span><span class="n">field</span><span class="p">(</span><span class="n">default_factory</span><span class="o">=</span><span class="nb">list</span><span class="p">)</span>
    <span class="n">subjects</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="n">dataclasses</span><span class="o">.</span><span class="n">field</span><span class="p">(</span><span class="n">default_factory</span><span class="o">=</span><span class="nb">list</span><span class="p">)</span>
    <span class="n">location</span><span class="p">:</span> <span class="nb">tuple</span><span class="p">[</span><span class="nb">float</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="nb">float</span> <span class="o">|</span> <span class="kc">None</span><span class="p">]</span> <span class="o">=</span> <span class="n">dataclasses</span><span class="o">.</span><span class="n">field</span><span class="p">(</span>
        <span class="n">default_factory</span><span class="o">=</span><span class="k">lambda</span><span class="p">:</span> <span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
    <span class="p">)</span>
    <span class="n">rating</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span>


<span class="nd">@cache</span>
<span class="k">def</span><span class="w"> </span><span class="nf">_get_template</span><span class="p">(</span><span class="n">template</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Template</span><span class="p">:</span>
<span class="w">    </span><span class="sd">&quot;&quot;&quot;Get template from cache or load from file&quot;&quot;&quot;</span>
    <span class="k">return</span> <span class="n">Template</span><span class="p">(</span><span class="n">filename</span><span class="o">=</span><span class="n">template</span><span class="p">)</span>


<div class="viewcode-block" id="SidecarWriter">
<a class="viewcode-back" href="../../reference.html#osxphotos.SidecarWriter">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">SidecarWriter</span><span class="p">(</span><span class="n">_ExifMixin</span><span class="p">):</span>
<span class="w">    </span><span class="sd">&quot;&quot;&quot;Write sidecars for PhotoInfo objects</span>

<span class="sd">    Can write XMP, JSON, and exiftool sidecars</span>

<span class="sd">    Args:</span>
<span class="sd">        photo: PhotoInfo object</span>

<span class="sd">    Note:</span>
<span class="sd">        Sidecars are written by calling write_sidecar_files() which returns an ExportResults object</span>
<span class="sd">    &quot;&quot;&quot;</span>

    <span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">photo</span><span class="p">:</span> <span class="n">PhotoInfo</span><span class="p">):</span>
        <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">photo</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">_verbose</span> <span class="o">=</span> <span class="n">photo</span><span class="o">.</span><span class="n">_verbose</span>

<div class="viewcode-block" id="SidecarWriter.write_sidecar_files">
<a class="viewcode-back" href="../../reference.html#osxphotos.SidecarWriter.write_sidecar_files">[docs]</a>
    <span class="k">def</span><span class="w"> </span><span class="nf">write_sidecar_files</span><span class="p">(</span>
        <span class="bp">self</span><span class="p">,</span>
        <span class="n">dest</span><span class="p">:</span> <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">,</span>
        <span class="n">options</span><span class="p">:</span> <span class="n">ExportOptions</span><span class="p">,</span>
        <span class="n">export_results</span><span class="p">:</span> <span class="n">ExportResults</span><span class="p">,</span>
    <span class="p">)</span> <span class="o">-&gt;</span> <span class="n">ExportResults</span><span class="p">:</span>
<span class="w">        </span><span class="sd">&quot;&quot;&quot;Write sidecar files for the photo.</span>

<span class="sd">        Args:</span>
<span class="sd">            dest: destination path for photo that sidecars are being written for</span>
<span class="sd">            options: ExportOptions object that configures the sidecars</span>
<span class="sd">            export_results: ExportResults object containing information about the exported photo</span>

<span class="sd">        Returns: An ExportResults object containing information about the exported sidecar files</span>

<span class="sd">        Note:</span>
<span class="sd">            dest is the path to the the sidecar belongs to. THe sidecar filename will be</span>
<span class="sd">            dest.ext where ext is the extension for sidecar (e.g. xmp or json)</span>
<span class="sd">            If dest is &quot;img_1234.jpg&quot;, XMP sidecar would be &quot;img_1234.jpg.xmp&quot;</span>
<span class="sd">            Use ExportOptions(sidecar_drop_ext) to drop the image extension from the sidecar filename</span>
<span class="sd">            (e.g. &quot;img_1234.xmp&quot;)</span>
<span class="sd">        &quot;&quot;&quot;</span>

        <span class="c1"># if ExportDB isn&#39;t provided, use a temporary in-memory database</span>
        <span class="c1"># this allows SidecarWriter to be used independently of PhotoExporter</span>
        <span class="n">export_db</span> <span class="o">=</span> <span class="n">options</span><span class="o">.</span><span class="n">export_db</span> <span class="ow">or</span> <span class="n">ExportDBTemp</span><span class="p">()</span>

        <span class="c1"># likewise, if FileUtil isn&#39;t provided, use default</span>
        <span class="n">fileutil</span> <span class="o">=</span> <span class="n">options</span><span class="o">.</span><span class="n">fileutil</span> <span class="ow">or</span> <span class="n">FileUtilMacOS</span><span class="p">()</span> <span class="k">if</span> <span class="n">is_macos</span> <span class="k">else</span> <span class="n">FileUtilShUtil</span><span class="p">()</span>
        <span class="n">verbose</span> <span class="o">=</span> <span class="n">options</span><span class="o">.</span><span class="n">verbose</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">_verbose</span>

        <span class="c1"># define functions for adding markup</span>
        <span class="n">_filepath</span> <span class="o">=</span> <span class="n">add_rich_markup_tag</span><span class="p">(</span><span class="s2">&quot;filepath&quot;</span><span class="p">,</span> <span class="n">rich</span><span class="o">=</span><span class="n">options</span><span class="o">.</span><span class="n">rich</span><span class="p">)</span>

        <span class="c1"># export metadata</span>
        <span class="n">sidecars</span> <span class="o">=</span> <span class="p">[]</span>
        <span class="n">sidecar_json_files_skipped</span> <span class="o">=</span> <span class="p">[]</span>
        <span class="n">sidecar_json_files_written</span> <span class="o">=</span> <span class="p">[]</span>
        <span class="n">sidecar_exiftool_files_skipped</span> <span class="o">=</span> <span class="p">[]</span>
        <span class="n">sidecar_exiftool_files_written</span> <span class="o">=</span> <span class="p">[]</span>
        <span class="n">sidecar_xmp_files_skipped</span> <span class="o">=</span> <span class="p">[]</span>
        <span class="n">sidecar_xmp_files_written</span> <span class="o">=</span> <span class="p">[]</span>

        <span class="n">dest_suffix</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span> <span class="k">if</span> <span class="n">options</span><span class="o">.</span><span class="n">sidecar_drop_ext</span> <span class="k">else</span> <span class="n">dest</span><span class="o">.</span><span class="n">suffix</span>
        <span class="n">exif_options</span> <span class="o">=</span> <span class="n">exif_options_from_options</span><span class="p">(</span><span class="n">options</span><span class="p">)</span>
        <span class="k">if</span> <span class="n">options</span><span class="o">.</span><span class="n">sidecar</span> <span class="o">&amp;</span> <span class="n">SIDECAR_JSON</span><span class="p">:</span>
            <span class="n">sidecar_filename</span> <span class="o">=</span> <span class="n">dest</span><span class="o">.</span><span class="n">parent</span> <span class="o">/</span> <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">(</span>
                <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">dest</span><span class="o">.</span><span class="n">stem</span><span class="si">}{</span><span class="n">dest_suffix</span><span class="si">}</span><span class="s2">.json&quot;</span>
            <span class="p">)</span>
            <span class="n">sidecar_str</span> <span class="o">=</span> <span class="n">exiftool_json_sidecar</span><span class="p">(</span>
                <span class="n">photo</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">photo</span><span class="p">,</span>
                <span class="n">filename</span><span class="o">=</span><span class="n">dest</span><span class="o">.</span><span class="n">name</span><span class="p">,</span>
                <span class="n">options</span><span class="o">=</span><span class="n">exif_options</span><span class="p">,</span>
            <span class="p">)</span>
            <span class="n">sidecars</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
                <span class="p">(</span>
                    <span class="n">sidecar_filename</span><span class="p">,</span>
                    <span class="n">sidecar_str</span><span class="p">,</span>
                    <span class="n">sidecar_json_files_written</span><span class="p">,</span>
                    <span class="n">sidecar_json_files_skipped</span><span class="p">,</span>
                    <span class="s2">&quot;JSON&quot;</span><span class="p">,</span>
                <span class="p">)</span>
            <span class="p">)</span>

        <span class="k">if</span> <span class="n">options</span><span class="o">.</span><span class="n">sidecar</span> <span class="o">&amp;</span> <span class="n">SIDECAR_EXIFTOOL</span><span class="p">:</span>
            <span class="n">sidecar_filename</span> <span class="o">=</span> <span class="n">dest</span><span class="o">.</span><span class="n">parent</span> <span class="o">/</span> <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">(</span>
                <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">dest</span><span class="o">.</span><span class="n">stem</span><span class="si">}{</span><span class="n">dest_suffix</span><span class="si">}</span><span class="s2">.json&quot;</span>
            <span class="p">)</span>
            <span class="n">sidecar_str</span> <span class="o">=</span> <span class="n">exiftool_json_sidecar</span><span class="p">(</span>
                <span class="n">photo</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">photo</span><span class="p">,</span>
                <span class="n">tag_groups</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
                <span class="n">filename</span><span class="o">=</span><span class="n">dest</span><span class="o">.</span><span class="n">name</span><span class="p">,</span>
                <span class="n">options</span><span class="o">=</span><span class="n">exif_options</span><span class="p">,</span>
            <span class="p">)</span>
            <span class="n">sidecars</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
                <span class="p">(</span>
                    <span class="n">sidecar_filename</span><span class="p">,</span>
                    <span class="n">sidecar_str</span><span class="p">,</span>
                    <span class="n">sidecar_exiftool_files_written</span><span class="p">,</span>
                    <span class="n">sidecar_exiftool_files_skipped</span><span class="p">,</span>
                    <span class="s2">&quot;exiftool&quot;</span><span class="p">,</span>
                <span class="p">)</span>
            <span class="p">)</span>

        <span class="k">if</span> <span class="n">options</span><span class="o">.</span><span class="n">sidecar</span> <span class="o">&amp;</span> <span class="n">SIDECAR_XMP</span><span class="p">:</span>
            <span class="n">sidecar_filename</span> <span class="o">=</span> <span class="n">dest</span><span class="o">.</span><span class="n">parent</span> <span class="o">/</span> <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">(</span>
                <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">dest</span><span class="o">.</span><span class="n">stem</span><span class="si">}{</span><span class="n">dest_suffix</span><span class="si">}</span><span class="s2">.xmp&quot;</span>
            <span class="p">)</span>
            <span class="n">sidecar_str</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">xmp_sidecar</span><span class="p">(</span>
                <span class="n">extension</span><span class="o">=</span><span class="n">dest</span><span class="o">.</span><span class="n">suffix</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span> <span class="k">if</span> <span class="n">dest</span><span class="o">.</span><span class="n">suffix</span> <span class="k">else</span> <span class="kc">None</span><span class="p">,</span> <span class="n">options</span><span class="o">=</span><span class="n">options</span>
            <span class="p">)</span>
            <span class="n">sidecars</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
                <span class="p">(</span>
                    <span class="n">sidecar_filename</span><span class="p">,</span>
                    <span class="n">sidecar_str</span><span class="p">,</span>
                    <span class="n">sidecar_xmp_files_written</span><span class="p">,</span>
                    <span class="n">sidecar_xmp_files_skipped</span><span class="p">,</span>
                    <span class="s2">&quot;XMP&quot;</span><span class="p">,</span>
                <span class="p">)</span>
            <span class="p">)</span>

        <span class="k">for</span> <span class="n">data</span> <span class="ow">in</span> <span class="n">sidecars</span><span class="p">:</span>
            <span class="n">sidecar_filename</span> <span class="o">=</span> <span class="n">data</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
            <span class="n">sidecar_str</span> <span class="o">=</span> <span class="n">data</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
            <span class="n">files_written</span> <span class="o">=</span> <span class="n">data</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span>
            <span class="n">files_skipped</span> <span class="o">=</span> <span class="n">data</span><span class="p">[</span><span class="mi">3</span><span class="p">]</span>
            <span class="n">sidecar_type</span> <span class="o">=</span> <span class="n">data</span><span class="p">[</span><span class="mi">4</span><span class="p">]</span>

            <span class="n">sidecar_digest</span> <span class="o">=</span> <span class="n">hexdigest</span><span class="p">(</span><span class="n">sidecar_str</span><span class="p">)</span>
            <span class="n">sidecar_record</span> <span class="o">=</span> <span class="n">export_db</span><span class="o">.</span><span class="n">create_or_get_file_record</span><span class="p">(</span>
                <span class="n">sidecar_filename</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">photo</span><span class="o">.</span><span class="n">uuid</span>
            <span class="p">)</span>
            <span class="n">write_sidecar</span> <span class="o">=</span> <span class="p">(</span>
                <span class="ow">not</span> <span class="p">(</span><span class="n">options</span><span class="o">.</span><span class="n">update</span> <span class="ow">or</span> <span class="n">options</span><span class="o">.</span><span class="n">force_update</span><span class="p">)</span>
                <span class="ow">or</span> <span class="p">(</span>
                    <span class="p">(</span><span class="n">options</span><span class="o">.</span><span class="n">update</span> <span class="ow">or</span> <span class="n">options</span><span class="o">.</span><span class="n">force_update</span><span class="p">)</span>
                    <span class="ow">and</span> <span class="ow">not</span> <span class="n">sidecar_filename</span><span class="o">.</span><span class="n">exists</span><span class="p">()</span>
                <span class="p">)</span>
                <span class="ow">or</span> <span class="p">(</span>
                    <span class="p">(</span><span class="n">options</span><span class="o">.</span><span class="n">update</span> <span class="ow">or</span> <span class="n">options</span><span class="o">.</span><span class="n">force_update</span><span class="p">)</span>
                    <span class="ow">and</span> <span class="p">(</span><span class="n">sidecar_digest</span> <span class="o">!=</span> <span class="n">sidecar_record</span><span class="o">.</span><span class="n">digest</span><span class="p">)</span>
                    <span class="ow">or</span> <span class="ow">not</span> <span class="n">fileutil</span><span class="o">.</span><span class="n">cmp_file_sig</span><span class="p">(</span>
                        <span class="n">sidecar_filename</span><span class="p">,</span> <span class="n">sidecar_record</span><span class="o">.</span><span class="n">dest_sig</span>
                    <span class="p">)</span>
                <span class="p">)</span>
            <span class="p">)</span>
            <span class="k">if</span> <span class="n">write_sidecar</span><span class="p">:</span>
                <span class="n">verbose</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Writing </span><span class="si">{</span><span class="n">sidecar_type</span><span class="si">}</span><span class="s2"> sidecar </span><span class="si">{</span><span class="n">_filepath</span><span class="p">(</span><span class="n">sidecar_filename</span><span class="p">)</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
                <span class="n">files_written</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">sidecar_filename</span><span class="p">))</span>
                <span class="k">if</span> <span class="ow">not</span> <span class="n">options</span><span class="o">.</span><span class="n">dry_run</span><span class="p">:</span>
                    <span class="bp">self</span><span class="o">.</span><span class="n">_write_sidecar</span><span class="p">(</span><span class="n">sidecar_filename</span><span class="p">,</span> <span class="n">sidecar_str</span><span class="p">)</span>
                    <span class="n">sidecar_record</span><span class="o">.</span><span class="n">digest</span> <span class="o">=</span> <span class="n">sidecar_digest</span>
                    <span class="n">sidecar_record</span><span class="o">.</span><span class="n">dest_sig</span> <span class="o">=</span> <span class="n">fileutil</span><span class="o">.</span><span class="n">file_sig</span><span class="p">(</span><span class="n">sidecar_filename</span><span class="p">)</span>
            <span class="k">else</span><span class="p">:</span>
                <span class="n">verbose</span><span class="p">(</span>
                    <span class="sa">f</span><span class="s2">&quot;Skipped up to date </span><span class="si">{</span><span class="n">sidecar_type</span><span class="si">}</span><span class="s2"> sidecar </span><span class="si">{</span><span class="n">_filepath</span><span class="p">(</span><span class="n">sidecar_filename</span><span class="p">)</span><span class="si">}</span><span class="s2">&quot;</span>
                <span class="p">)</span>
                <span class="n">files_skipped</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">sidecar_filename</span><span class="p">))</span>

        <span class="n">results</span> <span class="o">=</span> <span class="n">ExportResults</span><span class="p">(</span>
            <span class="n">sidecar_json_written</span><span class="o">=</span><span class="n">sidecar_json_files_written</span><span class="p">,</span>
            <span class="n">sidecar_json_skipped</span><span class="o">=</span><span class="n">sidecar_json_files_skipped</span><span class="p">,</span>
            <span class="n">sidecar_exiftool_written</span><span class="o">=</span><span class="n">sidecar_exiftool_files_written</span><span class="p">,</span>
            <span class="n">sidecar_exiftool_skipped</span><span class="o">=</span><span class="n">sidecar_exiftool_files_skipped</span><span class="p">,</span>
            <span class="n">sidecar_xmp_written</span><span class="o">=</span><span class="n">sidecar_xmp_files_written</span><span class="p">,</span>
            <span class="n">sidecar_xmp_skipped</span><span class="o">=</span><span class="n">sidecar_xmp_files_skipped</span><span class="p">,</span>
        <span class="p">)</span>
        <span class="c1"># write user sidecar files if specified</span>
        <span class="k">if</span> <span class="n">options</span><span class="o">.</span><span class="n">sidecar_template</span><span class="p">:</span>
            <span class="n">results</span> <span class="o">+=</span> <span class="bp">self</span><span class="o">.</span><span class="n">write_user_sidecar_files</span><span class="p">(</span>
                <span class="n">dest</span><span class="o">=</span><span class="n">dest</span><span class="p">,</span> <span class="n">options</span><span class="o">=</span><span class="n">options</span><span class="p">,</span> <span class="n">export_results</span><span class="o">=</span><span class="n">export_results</span>
            <span class="p">)</span>

        <span class="k">if</span> <span class="n">options</span><span class="o">.</span><span class="n">touch_file</span><span class="p">:</span>
            <span class="n">all_sidecars</span> <span class="o">=</span> <span class="p">(</span>
                <span class="n">sidecar_json_files_written</span>
                <span class="o">+</span> <span class="n">sidecar_exiftool_files_written</span>
                <span class="o">+</span> <span class="n">sidecar_xmp_files_written</span>
                <span class="o">+</span> <span class="n">sidecar_json_files_skipped</span>
                <span class="o">+</span> <span class="n">sidecar_exiftool_files_skipped</span>
                <span class="o">+</span> <span class="n">sidecar_xmp_files_skipped</span>
                <span class="o">+</span> <span class="n">results</span><span class="o">.</span><span class="n">sidecar_user_written</span>
                <span class="o">+</span> <span class="n">results</span><span class="o">.</span><span class="n">sidecar_user_skipped</span>
            <span class="p">)</span>
            <span class="n">results</span> <span class="o">+=</span> <span class="n">touch_files</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">photo</span><span class="p">,</span> <span class="n">all_sidecars</span><span class="p">,</span> <span class="n">options</span><span class="p">)</span>

            <span class="c1"># update destination signatures in database</span>
            <span class="k">for</span> <span class="n">sidecar_filename</span> <span class="ow">in</span> <span class="n">all_sidecars</span><span class="p">:</span>
                <span class="n">sidecar_record</span> <span class="o">=</span> <span class="n">export_db</span><span class="o">.</span><span class="n">create_or_get_file_record</span><span class="p">(</span>
                    <span class="n">sidecar_filename</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">photo</span><span class="o">.</span><span class="n">uuid</span>
                <span class="p">)</span>
                <span class="n">sidecar_record</span><span class="o">.</span><span class="n">dest_sig</span> <span class="o">=</span> <span class="n">fileutil</span><span class="o">.</span><span class="n">file_sig</span><span class="p">(</span><span class="n">sidecar_filename</span><span class="p">)</span>

        <span class="k">return</span> <span class="n">results</span></div>


<div class="viewcode-block" id="SidecarWriter.write_user_sidecar_files">
<a class="viewcode-back" href="../../reference.html#osxphotos.SidecarWriter.write_user_sidecar_files">[docs]</a>
    <span class="k">def</span><span class="w"> </span><span class="nf">write_user_sidecar_files</span><span class="p">(</span>
        <span class="bp">self</span><span class="p">,</span>
        <span class="n">dest</span><span class="p">:</span> <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">,</span>
        <span class="n">options</span><span class="p">:</span> <span class="n">ExportOptions</span><span class="p">,</span>
        <span class="n">export_results</span><span class="p">:</span> <span class="n">ExportResults</span><span class="p">,</span>
    <span class="p">)</span> <span class="o">-&gt;</span> <span class="n">ExportResults</span><span class="p">:</span>
<span class="w">        </span><span class="sd">&quot;&quot;&quot;Write user sidecar files for the photo.</span>

<span class="sd">        Args:</span>
<span class="sd">            dest: destination path for photo that sidecars are being written for</span>
<span class="sd">            options: ExportOptions object that configures the sidecars</span>
<span class="sd">            export_results: ExportResults object with information about the exorted photos</span>

<span class="sd">        Returns: An ExportResults object containing information about the exported sidecar files</span>
<span class="sd">        &quot;&quot;&quot;</span>
        <span class="n">verbose</span> <span class="o">=</span> <span class="n">options</span><span class="o">.</span><span class="n">verbose</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">_verbose</span>

        <span class="c1"># define functions for adding markup</span>
        <span class="n">_filepath</span> <span class="o">=</span> <span class="n">add_rich_markup_tag</span><span class="p">(</span><span class="s2">&quot;filepath&quot;</span><span class="p">,</span> <span class="n">rich</span><span class="o">=</span><span class="n">options</span><span class="o">.</span><span class="n">rich</span><span class="p">)</span>

        <span class="n">sidecar_user_written</span> <span class="o">=</span> <span class="p">[]</span>
        <span class="n">sidecar_user_skipped</span> <span class="o">=</span> <span class="p">[]</span>
        <span class="n">sidecar_user_error</span> <span class="o">=</span> <span class="p">[]</span>

        <span class="n">exif_options</span> <span class="o">=</span> <span class="n">exif_options_from_options</span><span class="p">(</span><span class="n">options</span><span class="p">)</span>

        <span class="k">for</span> <span class="p">(</span>
            <span class="n">template_file</span><span class="p">,</span>
            <span class="n">filename_template</span><span class="p">,</span>
            <span class="n">template_options</span><span class="p">,</span>
        <span class="p">)</span> <span class="ow">in</span> <span class="n">options</span><span class="o">.</span><span class="n">sidecar_template</span><span class="p">:</span>
            <span class="n">strip_whitespace</span> <span class="o">=</span> <span class="s2">&quot;strip_whitespace&quot;</span> <span class="ow">in</span> <span class="n">template_options</span>
            <span class="n">strip_lines</span> <span class="o">=</span> <span class="s2">&quot;strip_lines&quot;</span> <span class="ow">in</span> <span class="n">template_options</span>
            <span class="n">write_skipped</span> <span class="o">=</span> <span class="s2">&quot;write_skipped&quot;</span> <span class="ow">in</span> <span class="n">template_options</span>
            <span class="n">skip_zero</span> <span class="o">=</span> <span class="s2">&quot;skip_zero&quot;</span> <span class="ow">in</span> <span class="n">template_options</span>
            <span class="n">catch_errors</span> <span class="o">=</span> <span class="s2">&quot;catch_errors&quot;</span> <span class="ow">in</span> <span class="n">template_options</span>
            <span class="c1"># Render the sidecar filename</span>
            <span class="n">template_filename</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_render_sidecar_filename</span><span class="p">(</span>
                <span class="n">filepath</span><span class="o">=</span><span class="nb">str</span><span class="p">(</span><span class="n">dest</span><span class="p">),</span>
                <span class="n">filename_template</span><span class="o">=</span><span class="n">filename_template</span><span class="p">,</span>
                <span class="n">export_dir</span><span class="o">=</span><span class="nb">str</span><span class="p">(</span><span class="n">dest</span><span class="o">.</span><span class="n">parent</span><span class="p">),</span>
                <span class="n">exiftool_path</span><span class="o">=</span><span class="n">options</span><span class="o">.</span><span class="n">exiftool_path</span><span class="p">,</span>
            <span class="p">)</span>

            <span class="k">if</span> <span class="ow">not</span> <span class="n">template_filename</span><span class="p">:</span>
                <span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span>
                    <span class="sa">f</span><span class="s2">&quot;Invalid SIDECAR_FILENAME_TEMPLATE for --sidecar-template &#39;</span><span class="si">{</span><span class="n">filename_template</span><span class="si">}</span><span class="s2">&#39;&quot;</span>
                <span class="p">)</span>
                <span class="k">continue</span>

            <span class="n">sidecar_path</span> <span class="o">=</span> <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">(</span><span class="n">template_filename</span><span class="p">)</span>

            <span class="k">if</span> <span class="ow">not</span> <span class="n">write_skipped</span> <span class="ow">and</span> <span class="nb">str</span><span class="p">(</span><span class="n">dest</span><span class="p">)</span> <span class="ow">in</span> <span class="n">export_results</span><span class="o">.</span><span class="n">skipped</span><span class="p">:</span>
                <span class="n">sidecar_user_skipped</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">sidecar_path</span><span class="p">))</span>
                <span class="n">verbose</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Skipping existing sidecar file [filepath]</span><span class="si">{</span><span class="n">sidecar_path</span><span class="si">}</span><span class="s2">[/]&quot;</span><span class="p">)</span>
                <span class="k">continue</span>

            <span class="k">try</span><span class="p">:</span>
                <span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_render_user_sidecar</span><span class="p">(</span>
                    <span class="n">template_file</span><span class="o">=</span><span class="n">template_file</span><span class="p">,</span>
                    <span class="n">sidecar_path</span><span class="o">=</span><span class="n">sidecar_path</span><span class="p">,</span>
                    <span class="n">photo_path</span><span class="o">=</span><span class="n">dest</span><span class="p">,</span>
                    <span class="n">strip_whitespace</span><span class="o">=</span><span class="n">strip_whitespace</span><span class="p">,</span>
                    <span class="n">strip_lines</span><span class="o">=</span><span class="n">strip_lines</span><span class="p">,</span>
                    <span class="n">skip_zero</span><span class="o">=</span><span class="n">skip_zero</span><span class="p">,</span>
                    <span class="n">catch_errors</span><span class="o">=</span><span class="n">catch_errors</span><span class="p">,</span>
                    <span class="n">options</span><span class="o">=</span><span class="n">options</span><span class="p">,</span>
                    <span class="n">exif_options</span><span class="o">=</span><span class="n">exif_options</span><span class="p">,</span>
                <span class="p">)</span>
            <span class="k">except</span> <span class="ne">ValueError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
                <span class="n">logger</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Error writing sidecar </span><span class="si">{</span><span class="n">sidecar_path</span><span class="si">}</span><span class="s2">: </span><span class="si">{</span><span class="n">e</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
                <span class="n">sidecar_user_error</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="nb">str</span><span class="p">(</span><span class="n">sidecar_path</span><span class="p">),</span> <span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="p">)))</span>
                <span class="k">continue</span>

            <span class="k">if</span> <span class="n">result</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
                <span class="c1"># skip_zero triggered, skip this sidecar</span>
                <span class="k">continue</span>

            <span class="n">sidecar_str</span> <span class="o">=</span> <span class="n">result</span>
            <span class="n">verbose</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Writing sidecar file </span><span class="si">{</span><span class="n">_filepath</span><span class="p">(</span><span class="n">sidecar_path</span><span class="p">)</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
            <span class="n">sidecar_user_written</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">sidecar_path</span><span class="p">))</span>
            <span class="k">if</span> <span class="ow">not</span> <span class="n">options</span><span class="o">.</span><span class="n">dry_run</span><span class="p">:</span>
                <span class="k">try</span><span class="p">:</span>
                    <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">sidecar_path</span><span class="p">,</span> <span class="s2">&quot;w&quot;</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
                        <span class="n">f</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">sidecar_str</span><span class="p">)</span>
                <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
                    <span class="n">sidecar_user_error</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="p">))</span>

        <span class="n">results</span> <span class="o">=</span> <span class="n">ExportResults</span><span class="p">(</span>
            <span class="n">sidecar_user_written</span><span class="o">=</span><span class="n">sidecar_user_written</span><span class="p">,</span>
            <span class="n">sidecar_user_skipped</span><span class="o">=</span><span class="n">sidecar_user_skipped</span><span class="p">,</span>
            <span class="n">sidecar_user_error</span><span class="o">=</span><span class="n">sidecar_user_error</span><span class="p">,</span>
        <span class="p">)</span>
        <span class="k">return</span> <span class="n">results</span></div>


    <span class="k">def</span><span class="w"> </span><span class="nf">_render_sidecar_filename</span><span class="p">(</span>
        <span class="bp">self</span><span class="p">,</span>
        <span class="n">filepath</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
        <span class="n">filename_template</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
        <span class="n">export_dir</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
        <span class="n">exiftool_path</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
    <span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
<span class="w">        </span><span class="sd">&quot;&quot;&quot;Render sidecar filename template&quot;&quot;&quot;</span>
        <span class="n">render_options</span> <span class="o">=</span> <span class="n">RenderOptions</span><span class="p">(</span><span class="n">export_dir</span><span class="o">=</span><span class="n">export_dir</span><span class="p">,</span> <span class="n">filepath</span><span class="o">=</span><span class="n">filepath</span><span class="p">)</span>
        <span class="n">photo_template</span> <span class="o">=</span> <span class="n">PhotoTemplate</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">photo</span><span class="p">,</span> <span class="n">exiftool_path</span><span class="o">=</span><span class="n">exiftool_path</span><span class="p">)</span>
        <span class="n">template_filename</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="n">photo_template</span><span class="o">.</span><span class="n">render</span><span class="p">(</span>
            <span class="n">filename_template</span><span class="p">,</span> <span class="n">options</span><span class="o">=</span><span class="n">render_options</span>
        <span class="p">)</span>
        <span class="n">template_filename</span> <span class="o">=</span> <span class="n">template_filename</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="k">if</span> <span class="n">template_filename</span> <span class="k">else</span> <span class="kc">None</span>
        <span class="k">return</span> <span class="n">template_filename</span>

    <span class="k">def</span><span class="w"> </span><span class="nf">_render_user_sidecar</span><span class="p">(</span>
        <span class="bp">self</span><span class="p">,</span>
        <span class="n">template_file</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
        <span class="n">sidecar_path</span><span class="p">:</span> <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">,</span>
        <span class="n">photo_path</span><span class="p">:</span> <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">,</span>
        <span class="n">strip_whitespace</span><span class="p">:</span> <span class="nb">bool</span><span class="p">,</span>
        <span class="n">strip_lines</span><span class="p">:</span> <span class="nb">bool</span><span class="p">,</span>
        <span class="n">skip_zero</span><span class="p">:</span> <span class="nb">bool</span><span class="p">,</span>
        <span class="n">catch_errors</span><span class="p">:</span> <span class="nb">bool</span><span class="p">,</span>
        <span class="n">options</span><span class="p">:</span> <span class="n">ExportOptions</span><span class="p">,</span>
        <span class="n">exif_options</span><span class="p">:</span> <span class="n">ExifOptions</span><span class="p">,</span>
    <span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
<span class="w">        </span><span class="sd">&quot;&quot;&quot;Render user sidecar template and return data</span>

<span class="sd">        Returns:</span>
<span class="sd">            str: rendered sidecar data</span>
<span class="sd">            None: if skip_zero is True and sidecar is empty</span>
<span class="sd">            Exception: if catch_errors is True and an error occurred</span>

<span class="sd">        Raises:</span>
<span class="sd">            Raises ValueError if error and catch_errors is False</span>
<span class="sd">        &quot;&quot;&quot;</span>

        <span class="nb">vars</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_sidecar_variables</span><span class="p">(</span><span class="n">options</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>

        <span class="c1"># Render the template</span>
        <span class="k">try</span><span class="p">:</span>
            <span class="n">sidecar_template</span> <span class="o">=</span> <span class="n">_get_template</span><span class="p">(</span><span class="n">template_file</span><span class="p">)</span>
            <span class="n">sidecar_data</span> <span class="o">=</span> <span class="n">sidecar_template</span><span class="o">.</span><span class="n">render</span><span class="p">(</span>
                <span class="n">photo</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">photo</span><span class="p">,</span>
                <span class="n">sidecar_path</span><span class="o">=</span><span class="n">sidecar_path</span><span class="p">,</span>
                <span class="n">photo_path</span><span class="o">=</span><span class="n">photo_path</span><span class="p">,</span>
                <span class="n">description</span><span class="o">=</span><span class="nb">vars</span><span class="o">.</span><span class="n">description</span><span class="p">,</span>
                <span class="n">keywords</span><span class="o">=</span><span class="nb">vars</span><span class="o">.</span><span class="n">keywords</span><span class="p">,</span>
                <span class="n">persons</span><span class="o">=</span><span class="nb">vars</span><span class="o">.</span><span class="n">persons</span><span class="p">,</span>
                <span class="n">subjects</span><span class="o">=</span><span class="nb">vars</span><span class="o">.</span><span class="n">subjects</span><span class="p">,</span>
                <span class="n">extension</span><span class="o">=</span><span class="nb">vars</span><span class="o">.</span><span class="n">extension</span><span class="p">,</span>
                <span class="n">location</span><span class="o">=</span><span class="nb">vars</span><span class="o">.</span><span class="n">location</span><span class="p">,</span>
                <span class="n">version</span><span class="o">=</span><span class="n">__version__</span><span class="p">,</span>
                <span class="n">rating</span><span class="o">=</span><span class="nb">vars</span><span class="o">.</span><span class="n">rating</span><span class="p">,</span>
            <span class="p">)</span>
        <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
            <span class="k">if</span> <span class="n">catch_errors</span><span class="p">:</span>
                <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Error rendering sidecar template: </span><span class="si">{</span><span class="n">e</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span> <span class="kn">from</span><span class="w"> </span><span class="nn">e</span>
            <span class="k">raise</span> <span class="n">UserSidecarError</span><span class="p">(</span><span class="n">e</span><span class="p">)</span> <span class="kn">from</span><span class="w"> </span><span class="nn">e</span>

        <span class="k">if</span> <span class="n">strip_whitespace</span><span class="p">:</span>
            <span class="c1"># strip whitespace</span>
            <span class="n">sidecar_data</span> <span class="o">=</span> <span class="s2">&quot;</span><span class="se">\n</span><span class="s2">&quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">line</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span> <span class="k">for</span> <span class="n">line</span> <span class="ow">in</span> <span class="n">sidecar_data</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">&quot;</span><span class="se">\n</span><span class="s2">&quot;</span><span class="p">))</span>
        <span class="k">if</span> <span class="n">strip_lines</span><span class="p">:</span>
            <span class="c1"># strip blank lines</span>
            <span class="n">sidecar_data</span> <span class="o">=</span> <span class="s2">&quot;</span><span class="se">\n</span><span class="s2">&quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span>
                <span class="n">line</span> <span class="k">for</span> <span class="n">line</span> <span class="ow">in</span> <span class="n">sidecar_data</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">&quot;</span><span class="se">\n</span><span class="s2">&quot;</span><span class="p">)</span> <span class="k">if</span> <span class="n">line</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
            <span class="p">)</span>

        <span class="k">if</span> <span class="n">skip_zero</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">sidecar_data</span><span class="p">:</span>
            <span class="n">verbose</span> <span class="o">=</span> <span class="n">options</span><span class="o">.</span><span class="n">verbose</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">_verbose</span>
            <span class="n">_filepath</span> <span class="o">=</span> <span class="n">add_rich_markup_tag</span><span class="p">(</span><span class="s2">&quot;filepath&quot;</span><span class="p">,</span> <span class="n">rich</span><span class="o">=</span><span class="n">options</span><span class="o">.</span><span class="n">rich</span><span class="p">)</span>
            <span class="n">verbose</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Skipping empty sidecar file </span><span class="si">{</span><span class="n">_filepath</span><span class="p">(</span><span class="n">sidecar_path</span><span class="p">)</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
            <span class="k">return</span> <span class="kc">None</span>

        <span class="k">return</span> <span class="n">sidecar_data</span>

<div class="viewcode-block" id="SidecarWriter.xmp_sidecar">
<a class="viewcode-back" href="../../reference.html#osxphotos.SidecarWriter.xmp_sidecar">[docs]</a>
    <span class="k">def</span><span class="w"> </span><span class="nf">xmp_sidecar</span><span class="p">(</span>
        <span class="bp">self</span><span class="p">,</span>
        <span class="n">options</span><span class="p">:</span> <span class="n">ExportOptions</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
        <span class="n">extension</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
    <span class="p">):</span>
<span class="w">        </span><span class="sd">&quot;&quot;&quot;returns string for XMP sidecar</span>

<span class="sd">        Args:</span>
<span class="sd">            options (ExportOptions): options for export</span>
<span class="sd">            extension (Optional[str]): which extension to use for SidecarForExtension property</span>
<span class="sd">        &quot;&quot;&quot;</span>

        <span class="n">options</span> <span class="o">=</span> <span class="n">options</span> <span class="ow">or</span> <span class="n">ExportOptions</span><span class="p">()</span>
        <span class="n">xmp_template</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_xmp_template</span><span class="p">()</span>
        <span class="nb">vars</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_sidecar_variables</span><span class="p">(</span><span class="n">options</span><span class="p">,</span> <span class="n">extension</span><span class="p">)</span>
        <span class="n">xmp_str</span> <span class="o">=</span> <span class="n">xmp_template</span><span class="o">.</span><span class="n">render</span><span class="p">(</span>
            <span class="n">photo</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">photo</span><span class="p">,</span>
            <span class="n">description</span><span class="o">=</span><span class="nb">vars</span><span class="o">.</span><span class="n">description</span><span class="p">,</span>
            <span class="n">keywords</span><span class="o">=</span><span class="nb">vars</span><span class="o">.</span><span class="n">keywords</span><span class="p">,</span>
            <span class="n">persons</span><span class="o">=</span><span class="nb">vars</span><span class="o">.</span><span class="n">persons</span><span class="p">,</span>
            <span class="n">subjects</span><span class="o">=</span><span class="nb">vars</span><span class="o">.</span><span class="n">subjects</span><span class="p">,</span>
            <span class="n">extension</span><span class="o">=</span><span class="nb">vars</span><span class="o">.</span><span class="n">extension</span><span class="p">,</span>
            <span class="n">location</span><span class="o">=</span><span class="nb">vars</span><span class="o">.</span><span class="n">location</span><span class="p">,</span>
            <span class="n">version</span><span class="o">=</span><span class="n">__version__</span><span class="p">,</span>
            <span class="n">rating</span><span class="o">=</span><span class="nb">vars</span><span class="o">.</span><span class="n">rating</span><span class="p">,</span>
        <span class="p">)</span>

        <span class="c1"># remove extra lines that mako inserts from template</span>
        <span class="n">xmp_str</span> <span class="o">=</span> <span class="s2">&quot;</span><span class="se">\n</span><span class="s2">&quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">line</span> <span class="k">for</span> <span class="n">line</span> <span class="ow">in</span> <span class="n">xmp_str</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">&quot;</span><span class="se">\n</span><span class="s2">&quot;</span><span class="p">)</span> <span class="k">if</span> <span class="n">line</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span> <span class="o">!=</span> <span class="s2">&quot;&quot;</span><span class="p">)</span>
        <span class="k">return</span> <span class="n">xmp_str</span></div>


    <span class="k">def</span><span class="w"> </span><span class="nf">_xmp_template</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w">        </span><span class="sd">&quot;&quot;&quot;Return the mako template for XMP sidecar, creating it if necessary&quot;&quot;&quot;</span>
        <span class="k">global</span> <span class="n">_global_xmp_template</span>
        <span class="k">if</span> <span class="n">_global_xmp_template</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
            <span class="k">return</span> <span class="n">_global_xmp_template</span>

        <span class="n">xmp_template_file</span> <span class="o">=</span> <span class="p">(</span>
            <span class="n">_XMP_TEMPLATE_NAME_BETA</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">photo</span><span class="o">.</span><span class="n">_db</span><span class="o">.</span><span class="n">_beta</span> <span class="k">else</span> <span class="n">_XMP_TEMPLATE_NAME</span>
        <span class="p">)</span>
        <span class="n">_global_xmp_template</span> <span class="o">=</span> <span class="n">Template</span><span class="p">(</span>
            <span class="n">filename</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">_TEMPLATE_DIR</span><span class="p">,</span> <span class="n">xmp_template_file</span><span class="p">)</span>
        <span class="p">)</span>
        <span class="k">return</span> <span class="n">_global_xmp_template</span>

    <span class="k">def</span><span class="w"> </span><span class="nf">_sidecar_variables</span><span class="p">(</span>
        <span class="bp">self</span><span class="p">,</span>
        <span class="n">options</span><span class="p">:</span> <span class="n">ExportOptions</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
        <span class="n">extension</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
    <span class="p">)</span> <span class="o">-&gt;</span> <span class="n">SidecarVars</span><span class="p">:</span>
<span class="w">        </span><span class="sd">&quot;&quot;&quot;Render sidecar variables&quot;&quot;&quot;</span>

        <span class="n">render_options</span> <span class="o">=</span> <span class="n">options</span><span class="o">.</span><span class="n">render_options</span> <span class="ow">or</span> <span class="n">RenderOptions</span><span class="p">()</span>

        <span class="k">if</span> <span class="n">extension</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
            <span class="n">extension_path</span> <span class="o">=</span> <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">photo</span><span class="o">.</span><span class="n">original_filename</span><span class="p">)</span>
            <span class="n">extension</span> <span class="o">=</span> <span class="n">extension_path</span><span class="o">.</span><span class="n">suffix</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span> <span class="k">if</span> <span class="n">extension_path</span><span class="o">.</span><span class="n">suffix</span> <span class="k">else</span> <span class="kc">None</span>

        <span class="k">if</span> <span class="n">options</span><span class="o">.</span><span class="n">description_template</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
            <span class="n">render_options_description</span> <span class="o">=</span> <span class="n">dataclasses</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span>
                <span class="n">render_options</span><span class="p">,</span> <span class="n">expand_inplace</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">inplace_sep</span><span class="o">=</span><span class="s2">&quot;, &quot;</span>
            <span class="p">)</span>
            <span class="n">rendered</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">photo</span><span class="o">.</span><span class="n">render_template</span><span class="p">(</span>
                <span class="n">options</span><span class="o">.</span><span class="n">description_template</span><span class="p">,</span> <span class="n">render_options_description</span>
            <span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
            <span class="n">description</span> <span class="o">=</span> <span class="s2">&quot; &quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">rendered</span><span class="p">)</span> <span class="k">if</span> <span class="n">rendered</span> <span class="k">else</span> <span class="s2">&quot;&quot;</span>
            <span class="k">if</span> <span class="n">options</span><span class="o">.</span><span class="n">strip</span><span class="p">:</span>
                <span class="n">description</span> <span class="o">=</span> <span class="n">description</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
        <span class="k">else</span><span class="p">:</span>
            <span class="n">description</span> <span class="o">=</span> <span class="p">(</span>
                <span class="bp">self</span><span class="o">.</span><span class="n">photo</span><span class="o">.</span><span class="n">description</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">photo</span><span class="o">.</span><span class="n">description</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="k">else</span> <span class="s2">&quot;&quot;</span>
            <span class="p">)</span>

        <span class="n">keyword_list</span> <span class="o">=</span> <span class="p">[]</span>
        <span class="k">if</span> <span class="n">options</span><span class="o">.</span><span class="n">merge_exif_keywords</span><span class="p">:</span>
            <span class="n">keyword_list</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_get_exif_keywords</span><span class="p">())</span>

        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">photo</span><span class="o">.</span><span class="n">keywords</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">options</span><span class="o">.</span><span class="n">replace_keywords</span><span class="p">:</span>
            <span class="n">keyword_list</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">photo</span><span class="o">.</span><span class="n">keywords</span><span class="p">)</span>

        <span class="n">person_list</span> <span class="o">=</span> <span class="p">[]</span>
        <span class="k">if</span> <span class="n">options</span><span class="o">.</span><span class="n">persons</span><span class="p">:</span>
            <span class="k">if</span> <span class="n">options</span><span class="o">.</span><span class="n">merge_exif_persons</span><span class="p">:</span>
                <span class="n">person_list</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_get_exif_persons</span><span class="p">())</span>

            <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">photo</span><span class="o">.</span><span class="n">persons</span><span class="p">:</span>
                <span class="c1"># filter out _UNKNOWN_PERSON</span>
                <span class="n">person_list</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span>
                    <span class="p">[</span><span class="n">p</span> <span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">photo</span><span class="o">.</span><span class="n">persons</span> <span class="k">if</span> <span class="n">p</span> <span class="o">!=</span> <span class="n">_UNKNOWN_PERSON</span><span class="p">]</span>
                <span class="p">)</span>

            <span class="k">if</span> <span class="n">options</span><span class="o">.</span><span class="n">use_persons_as_keywords</span> <span class="ow">and</span> <span class="n">person_list</span><span class="p">:</span>
                <span class="n">keyword_list</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">person_list</span><span class="p">)</span>

        <span class="k">if</span> <span class="n">options</span><span class="o">.</span><span class="n">use_albums_as_keywords</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">photo</span><span class="o">.</span><span class="n">albums</span><span class="p">:</span>
            <span class="n">keyword_list</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">photo</span><span class="o">.</span><span class="n">albums</span><span class="p">)</span>

        <span class="k">if</span> <span class="n">options</span><span class="o">.</span><span class="n">keyword_template</span><span class="p">:</span>
            <span class="n">rendered_keywords</span> <span class="o">=</span> <span class="p">[]</span>
            <span class="n">render_options_keywords</span> <span class="o">=</span> <span class="n">dataclasses</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span>
                <span class="n">render_options</span><span class="p">,</span> <span class="n">none_str</span><span class="o">=</span><span class="n">_OSXPHOTOS_NONE_SENTINEL</span><span class="p">,</span> <span class="n">path_sep</span><span class="o">=</span><span class="s2">&quot;/&quot;</span>
            <span class="p">)</span>
            <span class="k">for</span> <span class="n">template_str</span> <span class="ow">in</span> <span class="n">options</span><span class="o">.</span><span class="n">keyword_template</span><span class="p">:</span>
                <span class="n">rendered</span><span class="p">,</span> <span class="n">unmatched</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">photo</span><span class="o">.</span><span class="n">render_template</span><span class="p">(</span>
                    <span class="n">template_str</span><span class="p">,</span> <span class="n">render_options_keywords</span>
                <span class="p">)</span>
                <span class="k">if</span> <span class="n">unmatched</span><span class="p">:</span>
                    <span class="n">logger</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span>
                        <span class="sa">f</span><span class="s2">&quot;Unmatched template substitution for template: </span><span class="si">{</span><span class="n">template_str</span><span class="si">}</span><span class="s2"> </span><span class="si">{</span><span class="n">unmatched</span><span class="si">}</span><span class="s2">&quot;</span>
                    <span class="p">)</span>
                <span class="n">rendered_keywords</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">rendered</span><span class="p">)</span>

            <span class="k">if</span> <span class="n">options</span><span class="o">.</span><span class="n">strip</span><span class="p">:</span>
                <span class="n">rendered_keywords</span> <span class="o">=</span> <span class="p">[</span><span class="n">keyword</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span> <span class="k">for</span> <span class="n">keyword</span> <span class="ow">in</span> <span class="n">rendered_keywords</span><span class="p">]</span>

            <span class="c1"># filter out any template values that didn&#39;t match by looking for sentinel</span>
            <span class="n">rendered_keywords</span> <span class="o">=</span> <span class="p">[</span>
                <span class="n">keyword</span>
                <span class="k">for</span> <span class="n">keyword</span> <span class="ow">in</span> <span class="n">rendered_keywords</span>
                <span class="k">if</span> <span class="n">_OSXPHOTOS_NONE_SENTINEL</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">keyword</span>
            <span class="p">]</span>

            <span class="n">keyword_list</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">rendered_keywords</span><span class="p">)</span>

        <span class="c1"># remove duplicates</span>
        <span class="c1"># sorted mainly to make testing the XMP file easier</span>
        <span class="k">if</span> <span class="n">keyword_list</span><span class="p">:</span>
            <span class="n">keyword_list</span> <span class="o">=</span> <span class="nb">sorted</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="nb">set</span><span class="p">(</span><span class="n">keyword_list</span><span class="p">)))</span>
        <span class="k">if</span> <span class="n">options</span><span class="o">.</span><span class="n">persons</span> <span class="ow">and</span> <span class="n">person_list</span><span class="p">:</span>
            <span class="n">person_list</span> <span class="o">=</span> <span class="nb">sorted</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="nb">set</span><span class="p">(</span><span class="n">person_list</span><span class="p">)))</span>

        <span class="n">subject_list</span> <span class="o">=</span> <span class="n">keyword_list</span>

        <span class="n">latlon</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">photo</span><span class="o">.</span><span class="n">location</span> <span class="k">if</span> <span class="n">options</span><span class="o">.</span><span class="n">location</span> <span class="k">else</span> <span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>

        <span class="k">if</span> <span class="n">options</span><span class="o">.</span><span class="n">favorite_rating</span><span class="p">:</span>
            <span class="n">rating</span> <span class="o">=</span> <span class="mi">5</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">photo</span><span class="o">.</span><span class="n">favorite</span> <span class="k">else</span> <span class="mi">0</span>
        <span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">photo</span><span class="o">.</span><span class="n">_db</span><span class="o">.</span><span class="n">_source</span> <span class="o">==</span> <span class="s2">&quot;iPhoto&quot;</span><span class="p">:</span>
            <span class="n">rating</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">photo</span><span class="o">.</span><span class="n">rating</span>
        <span class="k">else</span><span class="p">:</span>
            <span class="n">rating</span> <span class="o">=</span> <span class="kc">None</span>

        <span class="k">return</span> <span class="n">SidecarVars</span><span class="p">(</span>
            <span class="n">description</span><span class="o">=</span><span class="n">description</span><span class="p">,</span>
            <span class="n">extension</span><span class="o">=</span><span class="n">extension</span><span class="p">,</span>
            <span class="n">keywords</span><span class="o">=</span><span class="n">keyword_list</span><span class="p">,</span>
            <span class="n">persons</span><span class="o">=</span><span class="n">person_list</span><span class="p">,</span>
            <span class="n">subjects</span><span class="o">=</span><span class="n">subject_list</span><span class="p">,</span>
            <span class="n">location</span><span class="o">=</span><span class="n">latlon</span><span class="p">,</span>
            <span class="n">rating</span><span class="o">=</span><span class="n">rating</span><span class="p">,</span>
        <span class="p">)</span>

    <span class="k">def</span><span class="w"> </span><span class="nf">_write_sidecar</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filename</span><span class="p">,</span> <span class="n">sidecar_str</span><span class="p">):</span>
<span class="w">        </span><span class="sd">&quot;&quot;&quot;write sidecar_str to filename</span>
<span class="sd">        used for exporting sidecar info&quot;&quot;&quot;</span>
        <span class="k">if</span> <span class="ow">not</span> <span class="p">(</span><span class="n">filename</span> <span class="ow">or</span> <span class="n">sidecar_str</span><span class="p">):</span>
            <span class="k">raise</span> <span class="p">(</span>
                <span class="ne">ValueError</span><span class="p">(</span>
                    <span class="sa">f</span><span class="s2">&quot;filename </span><span class="si">{</span><span class="n">filename</span><span class="si">}</span><span class="s2"> and sidecar_str </span><span class="si">{</span><span class="n">sidecar_str</span><span class="si">}</span><span class="s2"> must not be None&quot;</span>
                <span class="p">)</span>
            <span class="p">)</span>

        <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="s2">&quot;w&quot;</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
            <span class="n">f</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">sidecar_str</span><span class="p">)</span></div>



<span class="k">def</span><span class="w"> </span><span class="nf">xmp_sidecar</span><span class="p">(</span>
    <span class="n">photo</span><span class="p">:</span> <span class="n">PhotoInfo</span><span class="p">,</span>
    <span class="n">options</span><span class="p">:</span> <span class="n">ExportOptions</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
    <span class="n">extension</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w">    </span><span class="sd">&quot;&quot;&quot;Returns string for XMP sidecar</span>

<span class="sd">    Args:</span>
<span class="sd">        photo: PhotoInfo object to generate sidecar for</span>
<span class="sd">        options (ExportOptions): options for export</span>
<span class="sd">        extension (Optional[str]): which extension to use for SidecarForExtension property</span>

<span class="sd">    Returns:</span>
<span class="sd">        str: string containing XMP sidecar</span>
<span class="sd">    &quot;&quot;&quot;</span>

    <span class="n">writer</span> <span class="o">=</span> <span class="n">SidecarWriter</span><span class="p">(</span><span class="n">photo</span><span class="p">)</span>
    <span class="k">return</span> <span class="n">writer</span><span class="o">.</span><span class="n">xmp_sidecar</span><span class="p">(</span><span class="n">options</span><span class="o">=</span><span class="n">options</span><span class="p">,</span> <span class="n">extension</span><span class="o">=</span><span class="n">extension</span><span class="p">)</span>


<span class="k">def</span><span class="w"> </span><span class="nf">exiftool_json_sidecar</span><span class="p">(</span>
    <span class="n">photo</span><span class="p">:</span> <span class="n">PhotoInfo</span><span class="p">,</span>
    <span class="n">options</span><span class="p">:</span> <span class="n">ExportOptions</span> <span class="o">|</span> <span class="n">ExifOptions</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
    <span class="n">tag_groups</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span><span class="p">,</span>
    <span class="n">filename</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w">    </span><span class="sd">&quot;&quot;&quot;Return JSON string for EXIF details for building exiftool JSON sidecar or sending commands to ExifTool.</span>
<span class="sd">        Does not include all the EXIF fields as those are likely already in the image.</span>

<span class="sd">    Args:</span>
<span class="sd">        options (ExportOptions or ExifOptions): options for export</span>
<span class="sd">        tag_groups (bool, default=True): if True, include tag groups in the output</span>
<span class="sd">        filename (str): name of target image file (without path); if not None, exiftool JSON signature will be included; if None, signature will not be included</span>

<span class="sd">    Returns: JSON str for dict of exiftool tags / values</span>
<span class="sd">    &quot;&quot;&quot;</span>
    <span class="n">exif_options</span> <span class="o">=</span> <span class="p">(</span>
        <span class="n">exif_options_from_options</span><span class="p">(</span><span class="n">options</span><span class="p">)</span>
        <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">options</span><span class="p">,</span> <span class="n">ExportOptions</span><span class="p">)</span>
        <span class="k">else</span> <span class="n">options</span>
    <span class="p">)</span>
    <span class="k">return</span> <span class="n">ExifWriter</span><span class="p">(</span><span class="n">photo</span><span class="p">)</span><span class="o">.</span><span class="n">exiftool_json_sidecar</span><span class="p">(</span>
        <span class="n">options</span><span class="o">=</span><span class="n">exif_options</span><span class="p">,</span>
        <span class="n">tag_groups</span><span class="o">=</span><span class="n">tag_groups</span><span class="p">,</span>
        <span class="n">filename</span><span class="o">=</span><span class="n">filename</span><span class="p">,</span>
    <span class="p">)</span>


<span class="k">def</span><span class="w"> </span><span class="nf">get_sidecar_file_with_template</span><span class="p">(</span>
    <span class="n">filepath</span><span class="p">:</span> <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">,</span>
    <span class="n">sidecar</span><span class="p">:</span> <span class="nb">bool</span><span class="p">,</span>
    <span class="n">sidecar_filename_template</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
    <span class="n">edited_suffix</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
    <span class="n">exiftool_path</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
<span class="w">    </span><span class="sd">&quot;&quot;&quot;Find sidecar file for photo with optional template for the sidecar and/or edited suffix&quot;&quot;&quot;</span>
    <span class="k">if</span> <span class="ow">not</span> <span class="p">(</span><span class="n">sidecar</span> <span class="ow">or</span> <span class="n">sidecar_filename_template</span><span class="p">):</span>
        <span class="k">return</span> <span class="kc">None</span>
    <span class="n">sidecar_file</span> <span class="o">=</span> <span class="kc">None</span>
    <span class="k">if</span> <span class="n">sidecar_filename_template</span><span class="p">:</span>
        <span class="k">if</span> <span class="n">sidecars</span> <span class="o">:=</span> <span class="n">render_photo_template_from_filepath</span><span class="p">(</span>
            <span class="n">filepath</span><span class="p">,</span>
            <span class="kc">None</span><span class="p">,</span>
            <span class="n">sidecar_filename_template</span><span class="p">,</span>
            <span class="n">exiftool_path</span><span class="p">,</span>
            <span class="kc">None</span><span class="p">,</span>
        <span class="p">):</span>
            <span class="c1"># allow multiple values to be rendered and checked</span>
            <span class="c1"># but only one will be used if more than one is valid</span>
            <span class="k">for</span> <span class="n">f</span> <span class="ow">in</span> <span class="n">sidecars</span><span class="p">:</span>
                <span class="n">sidecar_file</span> <span class="o">=</span> <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">(</span><span class="n">f</span><span class="p">)</span>
                <span class="k">if</span> <span class="n">sidecar_file</span><span class="o">.</span><span class="n">exists</span><span class="p">():</span>
                    <span class="k">break</span>
                <span class="k">else</span><span class="p">:</span>
                    <span class="n">sidecar_file</span> <span class="o">=</span> <span class="kc">None</span>
        <span class="k">else</span><span class="p">:</span>
            <span class="n">logger</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span>
                <span class="sa">f</span><span class="s2">&quot;Could not render sidecar template &#39;</span><span class="si">{</span><span class="n">sidecar_filename_template</span><span class="si">}</span><span class="s2">&#39; for &#39;</span><span class="si">{</span><span class="n">filepath</span><span class="si">}</span><span class="s2">&#39;&quot;</span>
            <span class="p">)</span>
    <span class="k">else</span><span class="p">:</span>
        <span class="n">sidecar_file</span> <span class="o">=</span> <span class="n">get_sidecar_for_file</span><span class="p">(</span><span class="n">filepath</span><span class="p">)</span>
    <span class="k">if</span> <span class="ow">not</span> <span class="n">sidecar_file</span> <span class="ow">or</span> <span class="ow">not</span> <span class="n">sidecar_file</span><span class="o">.</span><span class="n">exists</span><span class="p">():</span>
        <span class="k">if</span> <span class="n">edited_suffix</span><span class="p">:</span>
            <span class="c1"># try again with the edited suffix removed</span>
            <span class="n">filepath</span> <span class="o">=</span> <span class="n">strip_edited_suffix</span><span class="p">(</span><span class="n">filepath</span><span class="p">,</span> <span class="n">edited_suffix</span><span class="p">,</span> <span class="n">exiftool_path</span><span class="p">)</span>
            <span class="k">return</span> <span class="n">get_sidecar_file_with_template</span><span class="p">(</span>
                <span class="n">filepath</span><span class="p">,</span>
                <span class="n">sidecar</span><span class="p">,</span>
                <span class="n">sidecar_filename_template</span><span class="p">,</span>
                <span class="kc">None</span><span class="p">,</span>
                <span class="n">exiftool_path</span><span class="p">,</span>
            <span class="p">)</span>
        <span class="k">return</span> <span class="kc">None</span>
    <span class="k">return</span> <span class="n">sidecar_file</span>
</pre></div>
        </article>
      </div>
      <footer>
        
        <div class="related-pages">
          
          
        </div>
        <div class="bottom-of-page">
          <div class="left-details">
            <div class="copyright">
                Copyright &#169; 2021, Rhet Turnbull
            </div>
            Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
            
            <a href="https://github.com/pradyunsg/furo">Furo</a>
            
          </div>
          <div class="right-details">
            
          </div>
        </div>
        
      </footer>
    </div>
    <aside class="toc-drawer no-toc">
      
      
      
    </aside>
  </div>
</div><script src="../../_static/documentation_options.js?v=63568c49"></script>
    <script src="../../_static/doctools.js?v=9bcbadda"></script>
    <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
    <script src="../../_static/scripts/furo.js?v=46bd48cc"></script>
    <script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
    <script src="../../_static/copybutton.js?v=f281be69"></script>
    </body>
</html>